4.3.5.2 关联角色-基于路径

可通过此接口在用户目录为组织架构关联角色。

  • 基本信息

    请求地址:https://SDPC-IP:4433/api/v3/group/assignRoleByFullPath

    请求方式:POST

  • 请求体(Body)
参数 中文名称 必须 类型 描述
directoryDomain 用户目录唯一标识 string 用户目录唯一标识,在控制台点击用户目录设置即可查看。
本地用户目录的唯一标识为 local
外部用户目录示例:custom01339(唯一标识无需携带@)
fullPath 组织架构全路径 string 示例:/客服体系/专家中心/零信任专家组
role 角色列表 object 仅允许关联本地创建的角色,不允许关联远程同步的角色
├─ op 操作方式 string 操作类型。
取值范围:
append-追加更新(默认)
reset-重置
delete-删除。
├─ key 角色唯一标识 string key 是指标识角色的对象,即通过什么方式(或值)来关联指定的角色。零信任提供了三种标识来定义角色,即 id/name/externalId。
取值范围:
id-角色id
name-角色名称
externalId-角色外部id
├─ data 角色唯一标识对应数据 string / string[] data 是 key 值的结果,即若 key 的赋值是 name,那么 data 对应的赋值就是角色名,如: "role1", 关联多个角色时,可传参:["role1", "role2"]。若 key 的赋值是 externalId ,那么 data 就需要写角色的外部id值。
key 与 data 的对应取值示例如下:
id:1345c177-e4f6-11ee-835b-fefcfeefe529
name:role1 或 [ "role1", "role2" ]
externalId:202cb962ac59075b964b07152d234b70
  • 请求示例
curl --location --request POST 'https://SDPC-IP:4433/api/v3/group/assignRoleByFullPath?lang=zh-CN' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--data-raw '{
    "directoryDomain": "custom01339",
    "fullPath": "/客服体系/专家中心/零信任专家组",
    "role": {
        "op": "append",
        "key": "name",
        "data": [
            "role1",
            "role2"
        ]
    }
}'
  • 返回数据
参数 中文名称 类型 描述
code 响应码 string OK 表示成功,其他表示出错。具体含义请参考错误码定义
data 响应数据 object
msg 描述信息 string
traceId 调用链id string  
  • 响应示例
{
    "code": "OK",
    "data": {},
    "msg": "请求成功",
    "traceId": "00169ba2253e14ad"
}
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-11-20 11:03

results matching ""

    No results matching ""